RSDK-7962: organize sections in docs#266
Merged
njooma merged 7 commits intoviamrobotics:mainfrom Oct 8, 2024
Merged
Conversation
npentrel
approved these changes
Oct 8, 2024
Contributor
npentrel
left a comment
npentrel
left a comment
There was a problem hiding this comment.
LGTM if y'all are happy with this, thanks!
njooma
approved these changes
Oct 8, 2024
| import '../../utils.dart'; | ||
| import 'arm.dart'; | ||
|
|
||
| /// {@category Components} |
Member
There was a problem hiding this comment.
All of the category definitions in all of the service.dart files are actually unneeded since we don't export these files, so no documentation exists for these
Member
There was a problem hiding this comment.
(No need to do anything, just commenting here for documentation)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Jira ticket
There are three new topics, "Components", "Services", and "Common". Component/service classes were moved out of the "Viam SDK" category.
The common library is auto generated, so the
export_protos.dartfile checks for the common library and adds it to the new "Common" topic instead of "Protobuf Definitions" topic. You can only have one category at a time.Unfortunately, setting the category for specific classes seems to happen at class definition, so the "Common" topic would have to be set in the auto-generated file. Defining the category while exporting common classes (in
lib/viam_sdk.dart) did not work. I thought it should have, but I'm running into issues during testing this.There is an alternative, but less ideal, method of bringing attention to specific
commonclasses.Common.mdlinks the common classes that are specifically in the Viam SDK library.Note: I did try using the
subCategoriesto put everything under the Viam SDK category, but that doesn't seem to change the actual visuals based on what I've read and my own testing.